EnsureInitialized(T) Method (T, Func(T))

Task Parallel System.Threading

previous page next page

Initializes a target reference type using the specified function if it has not already been initialized.

Namespace:  System.Threading
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function EnsureInitialized(Of T As Class) ( _
	ByRef target As T, _
	valueFactory As Func(Of T) _
) As T
C#
public static T EnsureInitialized<T>(
	ref T target,
	Func<T> valueFactory
)
where T : class

Parameters

target
Type: T %
The reference of type T to initialize if it has not already been initialized.
valueFactory
Type: System..::.Func<(Of <(T>)>)
The Func<(Of <(T>)>) invoked to initialize the reference.

Type Parameters

T
The reference type of the reference to be initialized.

Return Value

The initialized reference of type T.

Remarks

This method may only be used on reference types, and valueFactory may not return a null reference (Nothing in Visual Basic). To ensure initialization of value types or to allow null reference types, see other overloads of EnsureInitialized.

This method may be used concurrently by multiple threads to initialize target. In the event that multiple threads access this method concurrently, multiple instances of T may be created, but only one will be stored into target. In such an occurrence, this method will not dispose of the objects that were not stored. If such objects must be disposed, it is up to the caller to determine if an object was not used and to then dispose of the object appropriately.

Exceptions

ExceptionCondition
System..::.MissingMemberExceptionType T does not have a default constructor.
System..::.InvalidOperationExceptionvalueFactory returned null.

See Also

previous page start next page